communicationMessage resource is to sent email notification to end customer.
URL
https://[localhost]:[port]/ecom-ux/v1/{businessId}/communicationMessage
Base URI Parameter
| Name | Type | Description | M/O |
|---|
| businessId | string | businessId string M Business unit identifier. Example: "PR" | M |
| Name | Type | Description | M/O |
|---|
| X-Correlation-ID | string | This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers.
Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b
| O |
| Name | Type | Description | M/O |
|---|
| client-id | string | Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg: 6f0ed16a7b494d76b2d60e05bc3b3332 | M |
| client-secret | string | Client secret value for Client Id Enforcement policy. Environment Specific Value, eg: e4CD4D43449846aA9D8Cb9c43f | M |
Data Model - Request
| field name | type | description | required (mandatory-M, optional-O, Not applicable- N/A, conditionalMandatory- C/M) |
|---|
| messageType | String | Type of the Notification Ex: EMAIL | M |
| templateId | String | TemplateId from the emarsys | M |
| source | String | Channel Source name | O |
| characteristic[] | Array | | M |
| characteristic[].valueType | String | valuetype for the characteristic field | M |
| characteristic[].value | String | value for the characteristic field | M |
| characteristic[].name | String | Name for the characteristic field | M |
| receiver[] | Array | | M |
| receiver[].id | String | Receiver unique id | M |
| receiver[].email | String | Receiver unique email addresss | O |
| receiver[].name | String | Receiver name | O |
| receiver[].phoneNumber | String | Receiver phoneNumber | O |
| sender[] | Array | | O |
| sender[].id | String | Sender unique id | O |
| sender[].name | String | Sender name | O |
| sender[].phoneNumber | String | Sender PhoneNumber | O |
| attachment[] | Array | | O |
| attachment[].name | String | Attachment name with file extension | O |
| attachment[].content | String | Attachment data in base64 format | O |
Key considerations
Emarsys Email Notification Implementation
-A valid template ID must be provided to trigger the email notification.
-The recipient's email address must be registered in Emarsys to successfully receive the email notification.
-Valid characteristic objects corresponding to the specified templateId must be included in the request.
-These required characteristics are defined and provided by business based on the selected template.
-characteristic.name should be configured by emarsys in template as placeholder to map dynamic values.
-The actual contents of the attachment object encoded as base64.
-NOTE: Emarsys will support for mentioned Formats → .doc, .docx, .pdf, .rtf, .csv, .xml, .xlsx, .xls, .txt
-attachment.name should be in attachment name corresponding encoded format of extension file example: sample.pdf .
API Specification URL: Post Notifications